Represents the diagnostics information of EtherCAT slaves' state. For further details, see KINGSTAR Analysis Console > Diagnostic Tool.
Inheritance Hierarchy
System.Object
IntervalZero.KINGSTAR.Base.Api.SlaveDiagnostics
Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0
Syntax
public class SlaveDiagnosticsPublic Class SlaveDiagnostics
The SlaveDiagnostics class exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | SlaveDiagnostics | Initializes a new instance of the SlaveDiagnostics class. |
Properties
| Name | Type | Description | Available State(s) | |
|---|---|---|---|---|
 | AbnormalState | UINT | The number of times the slave leave its state autonomously to a lower state without the master requests. | >= Offline |
| AlControl | USHORT | Controls the EtherCAT state machine. | >= Init |
| AlStatus | USHORT | The EtherCAT state plus an alarm bit. | >= Init |
| AlStatusCode | USHORT | AL Status Code. It displays the error code that indicates last time the problem the slave ran into. | >= Init |
| CyclicWc | UINT | The number of cycles the datagram which is responsible for processing data exchange of the slave was received back with an invalid working counter. | OP |
| DeviceType | UINT | The device type of the slave. | >= Init |
| DlStatus | USHORT | The EtherCAT loop state of each port. | OP |
| FixedAddress | USHORT | The fixed address of the slave. Set by the master during startup. Values start at 1001 and follow the link order. | >= Init |
| Flags | BYTE | Provides additional topology information about the slave. | >= Init |
| FrameCrc | BYTE | The Ethernet frame error count for each port. Error: an interference on the cable corrupts bits in the frame. | OP |
| LinkConnControl | BYTE | The value of the register 0x0101 of a slave. | OP |
| LinkConnStatus | BYTE | Reports the actual link state on each port of slave. The processing order is port 0→3→1→2. | >= Init |
| LinkPreset | BYTE | Reports the expected physical link on ports 1, 2, and 3 of a slave. The processing order is port 0→3→1→2. | >= Init |
| LinkStatus | BYTE | The EtherCAT link of a slave. | >= Init |
| LostLink | BYTE | Lost link count for each port. EtherCAT devices increment a Lost Link Counter in case of loss of physical link with neighboring devices. Error: the cable is faulty. | OP |
| MailboxIn | USHORT | The size of the slave's input mailbox buffer. 128 - 512 bytes are moderate. The size under 32 bytes is small. | >= Init |
| MailboxOut | USHORT | The size of the slave's output mailbox buffer. 128 - 512 bytes are moderate. The size under 32 bytes is small. | >= Init |
| Name | char | The name of the slave. | >= Init |
| NotPresent | UINT | The number of times the master lost the physical link with the slave. | >= Offline |
| PhyCrc | BYTE | The physical layer communication error count for each port. Error: the cable is unplugged. | OP |
| PortAddress | USHORT | The fixed address of the device expected connected to each port. | >= Init |
| ProductCode | UINT | The product code of the slave. | >= Init |
| RevisionNo | UINT | The revision number of the slave. | >= Init |
| SerialNo | UINT | The serial number of the slave. | >= Init |
| StationAddress | USHORT | Commonly called Alias address. It can be written by the master and is stored in the slave EEPROM. This value is kept when powering off and can be used to differentiate identical slaves. | >= Init |
| Type | char | The device type of the slave. | >= Init |
| VendorId | UINT | The vendor ID of the slave. | >= Init |
NOTE: The SlaveDiagnostics data is returned by GetStatus or GetStatusEx only at certain state(s) shown in the above "Available State(s)" column.
All the EtherCAT states and their transition order are listed below:
Offline → Init → Pre-Operational (PreOP) → Safe-Operational(SafeOP) → Operational (OP)
Offline → Init → Boot
For more information about all the states, please refer to EthercatState enumeration.
See also